步骤 8:添加自定义命令和生成文件

假设,出于本教程的需要,我们决定永远不使用平台 logexp 函数,而希望生成一个预先计算值表,以便用于 mysqrt 函数。在本部分中,我们将作为构建过程的一部分创建该表,然后将该表编译到我们的应用程序中。

首先,让我们从 MathFunctions/CMakeLists.txt 中删除对 logexp 函数的检查。然后,从 mysqrt.cxx 中删除对 HAVE_LOGHAVE_EXP 的检查。同时,我们可以删除 #include <cmath>

MathFunctions 子目录中,提供了一个名为 MakeTable.cxx 的新源文件,用于生成该表。

在审阅该文件之后,我们可以看出该表被制作成有效的 C++ 代码且输出文件名作为参数传入。

下一步是创建 MathFunctions/MakeTable.cmake。然后,向该文件添加适当的命令以构建 MakeTable 可执行文件,然后在构建过程的一部分中运行它。需要一些命令才能完成此操作。

首先,我们为 MakeTable 添加一个可执行文件。

MathFunctions/MakeTable.cmake
add_executable(MakeTable MakeTable.cxx)

在创建可执行文件之后,我们使用 target_link_libraries()tutorial_compiler_flags 添加到我们的可执行文件中。

然后我们添加一条自定义命令,该命令指定如何通过运行 MakeTable 来生成 Table.h

MathFunctions/MakeTable.cmake
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Table.h
  COMMAND MakeTable ${CMAKE_CURRENT_BINARY_DIR}/Table.h
  DEPENDS MakeTable
  )

接下来,我们必须让 CMake 知道 mysqrt.cxx 依赖于生成文件 Table.h。这是通过将生成的文件 Table.h 添加到库 SqrtLibrary 的源文件列表来完成的。

MathFunctions/CMakeLists.txt
  add_library(SqrtLibrary STATIC
              mysqrt.cxx
              ${CMAKE_CURRENT_BINARY_DIR}/Table.h
              )

我们还必须将当前二进制目录添加到包含目录列表中,以便 Table.h 可以被 mysqrt.cxx 找到和包含。

MathFunctions/CMakeLists.txt
  target_include_directories(SqrtLibrary PRIVATE
                             ${CMAKE_CURRENT_BINARY_DIR}
                             )

  # link SqrtLibrary to tutorial_compiler_flags

最后一步,我们需要将 MakeTable.cmake 包含在 MathFunctions/CMakeLists.txt 的顶部。

MathFunctions/CMakeLists.txt
  include(MakeTable.cmake)

现在让我们使用生成表。首先,修改 mysqrt.cxx 以包含 Table.h。接下来,我们可以重写 mysqrt 函数以使用表

MathFunctions/mysqrt.cxx
double mysqrt(double x)
{
  if (x <= 0) {
    return 0;
  }

  // use the table to help find an initial value
  double result = x;
  if (x >= 1 && x < 10) {
    std::cout << "Use the table to help find an initial value " << std::endl;
    result = sqrtTable[static_cast<int>(x)];
  }

  // do ten iterations
  for (int i = 0; i < 10; ++i) {
    if (result <= 0) {
      result = 0.1;
    }
    double delta = x - (result * result);
    result = result + 0.5 * delta / result;
    std::cout << "Computing sqrt of " << x << " to be " << result << std::endl;
  }

  return result;
}
}
}

运行 cmake 可执行文件或 cmake-gui 以配置项目,然后使用选定的构建工具构建它。

当此项目构建时,它将首先构建 MakeTable 可执行文件。然后它将运行 MakeTable 以生成 Table.h。最后,它将编译包括 Table.hmysqrt.cxx 以生成 MathFunctions 库。

运行教程可执行文件并验证它是否正在使用表。